MMhelper Version 1.5 Online Help

The MMhelper's Online help is combined of the following:

How to use help
What's new in this release
Help Topics:
    1 How To's
    2. The MMhelper Windows, Panels and Menus    
    3. Tips & Tricks
    4. Contents

How to use help

The support system is HTML based.
The MMhelper online help system can be launched at three different ways:
1. By hitting the F1 key.
2. By clicking the 'help' button (question mark) on the toolbar.
3. By opening the help/content menu.

What's new in this release

The MMhelper 1.5 has tree new main features,
'Rectangle': a new method of capturing.  If you can't capture elements at the target software,
in the standard methods ('Capture all visible components', 'Capture the pointed component'),
use the 'rectangle' method.
'Central Saving': A new saving system.
'Topic Wizard':  a Wizard that guides you through a simple procedure in creating help topics.

Look for updates in our site www.esmmi.com .

2. How To's
   This part specifies how to carry out various procedures in the
   MMHelper.

Click on the ‘HOW TO...’ which you want to get an explanation on.
1.   HOW TO use the 'Capture the pointed object' method.
2.   HOW TO use the 'Capture an entire application' method.
3.   HOW TO capture toolbar buttons.
4.   HOW TO use the 'Capture rectangle' method.
5.   HOW TO locate window.
6.   HOW TO create a 'Balloon'/'Statusbar' Help Topic.
7.   HOW TO create an 'External'/'Multimedia' Help Topic.
8.   HOW TO attach contents to objects.
9.   HOW TO activate the manual help topics.

     Back to menu.

1. HOW TO use the 'Capture the pointed component' method


To start capturing, follow this simple procedure:

1. In 'Builder Control Panel' click the triangle right to the 'Capture' button. From the menu
    select 'Capture the Pointed Component' (this is the default).
2. Click the 'Capture' button (notice that the button is changed - a little dot is  
    added to it standard look).
   The target application will launch, and the MMhelper help editor window will be minimized.
3. Place the mouse cursor over the component you want to capture in the target application. Click once on the right mouse         button (or use the Hotkey you determined 'Capture Key Select' window).
4. Your target application will automatically be minimized and the MMhelper help editor will become your active window,       
    containing a node, that represent the component that you have captured from the target application, in the Application Tree
    window.

Note: If you don't recognize a certain node in the application you have captured, the MMhelper has a special utility for that.
  See 'Locate Window'.

   Back to menu.

2. HOW TO use the 'Capture an entire application' method

To start capturing the entire application, follow this simple procedure:

1. In 'Builder Control Panel' click the triangle right to the 'Capture' button. From the menu
    select 'capture all visible components'.
2. Click the 'Capture' button (notice that the button is changed - three dots are  
    added to it standard look).
    The target application will launch, and the MMhelper help editor window will be
    minimized.
3. Place the mouse cursor anywhere over the target application and click once on the right mouse button (or use the Hotkey       you determined for the 'Capture Key Select' window).
4. Your target application will automatically be minimized and the MMhelper help editor will become your active window,
    containing a tree of all the captured components of your target application in the Application Tree window.

    Back to menu.

3. HOW TO capture toolbar buttons

In order to capture the toolbar buttons follow the next steps:

1. In 'Builder Control Panel' click the triangle right to the 'Capture' button. From the menu
    select 'Capture the Pointed Component' (this is the default).
2. Click the 'Capture' button (notice that the button is changed - a little dot is  
    added to it standard look).
   The target application will launch, and the MMhelper help editor window will be minimized.
3. Place the mouse cursor over the toolbar button you want to capture in the target application. Click once on the right mouse         button (or use the Hotkey you determined 'Capture Key Select' window).
4. Your target application will automatically be minimized and the MMhelper help editor will become your active window,       
    containing a node, that represent the toolbar button that you have captured from the target application, in the Application  
    Tree window.

    You have to repeat steps 2-3 for each button.
    
    Back to menu.

4. HOW TO use the 'Capture rectangle' method.

In order to use the 'Capture rectangle' method, follow the next steps:

1. In 'Builder Control Panel' click the triangle right to the 'Capture' button. From the menu
    select 'Capture rectangle'.
2. Click the 'Capture' button (notice that  a little rectangle is 
    added to its standard look).
    The target application will launch, and the Help Builder window will be
    minimized.
3. Using the right-mouse-button drag to create a rectangle over the desired
    component.
4. After marking the desired area, release the right-mouse-button. A dialog
    box will popup.
5. In the dialog box, enter a name for the rectangle, than press OK.
    A rectangle node, will be added the application tree, and will represent the area
    that was captured, as if the underlined component was captured.

Note: Attach only 'Multimedia' and 'External' manual help topics to rectangle node.

  Back to menu.

5. HOW TO locate window

'Locate Window' is a special utility that the MMhelper has for locating nodes that you can't recognize. In order to use this option, follow the next steps:

1.  Activate the application by clicking the 'Play' button from 'Builder Control Panel'.
2. Select the node you want to locate.
3.   Press the 'Locate Window' button in the 'Application Tree' window. It can
     also be done by 'Edit' menu or by right-mouse-button menu.

Now you'll get a presentation of the selected node encircled by a flickering
red and green frame.

    Back to meuu.

6.  HOW TO create a 'Balloon'/'Statusbar' help topic

1. Click on the icon 'Add Help help topic' in the Help Topic Window.
     The 'Topic Wizard' will be opened.
2.  From the main screen of the wizard select your desired type of help topic.
     Select 'Balloon' or 'Statusbar' and press 'Next'.
3.  At the edit box that was opened enter the text you want to popup in a balloon or
     appear on the help panel (if 'Statusbar' was selected).
     Press 'Next'.
4. At the third screen of the wizard under the title 'Enter Topic Name', you can see
    that the MMhelper has already set the value of the help topic as the default name, 
    but you can change it as you pleased.
    Press 'Finish'.

    Note: We recommend that you give meaningful names to your help topics.

   Back to menu.

7.  HOW TO create an 'External'/'Multimedia' help topic
      
1.  Click on the icon 'Add Help help topic' in the Help Topic Window.
     The 'Topic Wizard' will be opened.
2.  From the main screen of the wizard select your desired type of help topic.
     Select 'External' or 'Multimedia' and press 'Next'.
3. At the edit box that was opened enter your file name or use the 'Browse' button
     to search for the file in your computer.       
     Press 'Next'.
4. At the third screen of the wizard under the title 'Enter Topic Name', you can see
    that the MMhelper has already set the name of the file of the help topic as the
    default name, but you can change it as you pleased.
    Press 'Finish'.

Note: We recommend that you  make yourself a table in advance of which help content will be
           attached to which node, before you start attaching the suitable Help Contents to the
           desired nodes.

   Back to menu.

8. HOW TO Attach Contents TO Objects

After you have captured the target application and created your help topics you now need to attach the topics to the components of the target application. You can accomplish this task by simply dragging a help topic onto the desired node within the Application tree.

Back to menu.

9. HOW TO activate the manual help topics

In order to activate the manual help topics at the runtime engine, follow the next steps:

1. Place your mouse cursor over the control, which you have attached external help topic to.
    The question mark icon at the top-right corner of the target software will start flickering.
2. Left click on the question mark icon.  
3. Left click on the control or the component. The 'Help topics' window appears, it displays the list
    of the available manual help topics for that component.

Note: In case only one External or Multimadia is attach to the component, it will
           launch immediately when you left click the component.

4. Now you can display any topic you want by selecting it and clicking the 'Show'
    button, or simply by double-clicking the topic.

Note:
Automatic help topics are activated as soon as the user places the mouse cursor over the control. Any external or multimedia help topic is pre-loaded into memory, preventing unnecessary delay and creating a fast multimedia-based online help.

Back to menu.

3.The MMhelper Windows, Panels and Menus 
   Offers a verbal and graphic explanation of the MMhelper windows,
    panels and menus, and has references to the HOW TO.

windows:
1. Capture Key Select
2. Application Tree Window
3. Content list Window
4. Help Content Property Window
5. Help Topic Settings Window
6. Activation Property Window

panels:
1. Builder Control Panel
2. The Runtime Server and Help Panel
 
menus:
1. Help Edit Menus
2. Main Toolbar

Back to menu.

Windows

Capture Key Select

This window pops up after you select the target software when working on new project, or whenever you click
the 'Capture Key Select' icon.
Use this window to configure the trigger that will start the capturing process.
By default the capturing process is triggered by clicking the right mouse button.
However, You can  set the MMhelper help editor to use any of the function keys as the trigger,
or any combination of function key & the Shift or Ctrl keys (to select the combination simply click the desire keys).

Note: Before capturing it is important to verify that the Hotkey you have selected
          is not in use of the target software.

Notice that the 'Rectangle' capturing method is activated only with right-mouse-click.

Back to menu.

Application Tree  Window

This window represents a tree of the visual components of the target application that were captured and also used as an arena to attaching the help topics to the desired components of the target application.
This tree is created during the capturing process .  
Double clicking a node will open the Activation Property Window.

Note:
The node 'All' that is shown in the figure is related to the 'domain'
property that is not supported at the current version of the MMhelper, and will allow defining different kinds of help contents to different categories of users.

Toolbar buttons:
  Show property
Opens the Activation Property Window of the selected node.
  Delete
Deletes the selected Node.
Locate Window
If you don't recognize certain nodes in the application tree of the application you have captured, the MMhelper has a special utility for that. see 'locate window'.
Rename Node
Rename nodes in the application tree.

Back to menu.

Conteant list Window

Use this window to create or select the Help contents which can contain an avi file, text file, simple text balloon, status bar,external file, multimedia, etc.
For your convenience, in version 1.5  we have added the 'New Help Topic Wizard' that will guide you with a simple procedure in creating new help topics. The 'New Help Topic Wizard' is activated every time you click the 'Add content' icon.
When you want to edit how will your help topic look in general use the 'help topic settings' window, whenever you want to edit
a specific help topic, simply double click it.

Toolbar buttons:
New
Activates the 'New help topic wizard' that guides you in creating new help topics.
Delete
Deletes the selected help Content.
Cut
cuts the selected help Content.
Copy
copy the selected help Content.
Paste
pastes the help Content to the Help Topic Window.
 Show Properties
Opens the help Content Property Window of the selected Content.
View as List
Displays the help Contents as a list of icons.
View as Report
Displays the help Contents and their properties.
View as Icon
Displays the help Contents as icons.

The right-mouse-button menu:
(Active when help content is selected)
Open:
For your convenience, this option allows you to open 'External' or 'multimedia' help file with its associated application
from the 'Help Topic window' (you can establish this task also by double-clicking the help content).
Copy:
copy the selected help Content.
Cut:
Cut the selected help Content.
Paste:
Paste the selected help Content.
Delete:
Delete the selected help Content.
Rename:
Rename the help topic.
Arrange:
Arrange your help topics list by type, or by name.

Back to menu.

Use this window to define the integration of help contents with the target software.
The 'Help Topic Settings' window is combined of  four tabs. One for each type of help content.

StatusBar Tab

Use this tab to define the look, position and font of the added StatusBar.

Statusbar placement:
Locates the help panel  above or below your target application; and  choose whether this panel will appear inside your application window or outside of its borders.
The Help Panel default location is above and beyond the target application.
Colors:
Chooses your desired background and text color for your help panel and Statusbar.
Font Selection:
Define your Statusbar font's properties.

Note: The changes in the StatusBar properties can be previewed online at the preview section.

Balloon Tab

Use this tab to define how will your 'Ballon' help topics look.

Misc:
Set the time in seconds in which the balloon will popup after locating  the mouse cursor over
the desired component.
Colors:
Chooses your desired background and text color for your Balloon help topic.
Font Selection:
Define your Balloon font's properties.

Note: The changes in the Balloon properties can be previewed online at the bottom of the
Balloon tab.

Multimadia Tab

Use this tab to define whether your Multimedia help topics will be
activated manually or automatically, by default.

The help topics can be activated automatically - when the user places the mouse cursor over a certain control, or manually - when the user requests help, according to manual activation procedure.
Note: You can also set the activation method for each help content specifically.

External Tab:

Use this tab to define whether your External help topics will be
activated manually or automatically.

Back to menu.

Help Content Properties Window

Use this window to change the name or the value of the help topic.
The window opens from right mouse button options.

The figure below displays an example of  Topic properties window for 'External' help topic.

Back to menu.

Activation Properies Window

Use the 'Activation Properties' window to edit the properies of tree help topic types; 'Ballon', 'External'
and 'Multimedia'.
In oreder to open this window select your desired help topic node in the 'Application Tree' window, and
choose 'Properties' from right-mouse-click menu. 

Use the 'Balloon' 'Activation Properties' window to set the delay time from the moment the mouse cursor is over
the component you have attached the 'Balloon' to, untill the balloon pops-up.

Use the 'External' 'Activation Properties' window to determine whether the help topic is activated automatically (when the user places the mouse cursor over the component) or manually (upon user request).

If the action mode is automatically you can set the delay time (in seconds)  until this help topic pops up
at run time (when the activation method is 'manual' this property has no meaning).

Use the 'Multimedia' 'Activation Properties' window to determine whether the help topic is activated automatically (when the user places the mouse cursor over the component) or manually (upon user request).

If the action mode is automatically you can set the delay time (in seconds)  until this help topic pops up
at run time (when the activation method is 'manual' this property has no meaning).

Back to menu.

Panels

 Builder Control Panel

This control panel is the interface for communicating with your target software.
It contains several control buttons, and a list of all the open windows in the MMhelper Help Builder. Selecting one of the application from the list will make it the "active application" for the Help Builder.

The buttons:

Capture Application button
The capture button is different for every capturing method.
Use the triangle next to the button to choose between the capture method.

Capture the pointed component
This is the default button that will put you in 'Capture' mode using the 'Capture the pointed component' method.
Capture rectangle
Pressing this button will put you in 'Capture' mode using the 'Capture rectangle' method.
Capture all visible components
Pressing this button will put you in 'Capture' mode using the 'Capture all visible components' method.

To learn more about the process go to:

HOW TO use  the 'Capture the pointed component' method.
HOW TO use the 'Capture an entire application' method.
HOW TO capture toolbar buttons.
HOW TO use the 'Capture rectangle' method.

Play Application:
Runs the application, and lets you test your work.

Note:
When  you complete your testing make sure you close the MMhelper Run Time engine(right click on the icon in the taskbar - at the bottom of your screen).

Stop Application:
Minimizes the target  application.
Close Application:
Exits the target application.

Switch Window:
This button enables you to switch from the MMhelper window to the target application window and back.

Command line button:
Click this button if you need to specify any command line parameters in order to launch the target application

Back to menu.

The Runtime Server and Help Panel

Running the Runtime Server is essential for your new online help system to work. We recommend placing that application inside your user's start-up folder, so it can start automatically when Windows is loaded.
Notice our small logo at the lower right part of your screen, which will confirm that the Runtime server is active.

The Runtime Server has a right mouse button menu. The menu enables to close the MMserver or disable it. If  you close the server- the target applications will be close too. If  you will disable the server the target application will stay open and only the server will be disabled.

The MMhelper Runtime Help Engine is a background server application, which has two main functions:

1. Tracking the user and the target software activities.
2. Activating the attached help topics when needed, according to what was specified in the MMhelper Builder.

The help topics can be activated automatically - when the user places the mouse cursor over a certain control, or manually - when the user requests help, according to manual activation procedure.

When your application runs, the MMhelper will identify it and attach the Help Panel to it, according to its definitions.

The Help Panel has two purposes:
1. It displays the Status bar contents you've attached to the application.
2. It lets you know whenever the mouse cursor is over a control to which manual help topics are attached. The yellow light in the question mark icon turns red each time your mouse cursor is over such a control.

Back to menu.

Menus

Help Edit Menus

File
View
Window
Help

File:
File related operations.
New Project:
Opens a dialog box that lets you choose target application to which you want to create a new online help system.
Open:
Opens a dialog box that lets you select an existing *.MHT file (MMhelper file) you want to edit.
Recently Used Files:
Displays a list of all files you've recently work on in the Help Builder, and enables to open them.
Save:
Saves the active file to disk.
Close:
Closes the active file.
Exit:
Closes all open windows in the Help Builder, including the target application, and exits the Help  Builder.

Window

Operations on the Help Builder windows.

Cascade:
Arrange all open windows one over the other.
Tile:
Arrange all open windows to fit in the main window area.
Minimize All:
Minimizes all windows in the Help Builder.
A list of all opened windows:
The active window is marked. You can switch to any other open window by clicking  its name in the list.

View

Displays or hide MMhelper help editor components.

Control Panel:
Opens the control panel.
Application Tree:
When this item is checked the 'Application Tree'
window is displayed in addition to the 'Help Topic' window.
Capture Key Select:
Opens the 'Capture Key Select' window, where you can
select the trigger (Hotkey or right-mouse-button) that will start the capture process.
Help Topics Settings:
Opens the 'Help Topics Settings' window,
were you can define default settings for your help contents

Help

content:
(also available as an icon )

Registration form:
This is a trial version of the MMhelper. You may use it for 30 days. If you would like to continue using the MMhelper after this evaluation period you must purchase a licensed version.
This menu item includes a registration form.

Quick start:
This is a QuickStart Tutorial session that will guide you with a simple procedure in creating your
own online help for 3^rd party applications.

Register:
Registered users of the MMhelper will receive a personal code. Enter your code at the appropriate place at the Register menu item.

About:
Display a quick information about E.S.M.M.I.

Back to menu.

Main Toolbar

New Project:
Opens a dialog box that lets you choose target application to which you want to create a new online help system.
Open:
Opens a dialog box that lets you select an existing *.MHT file (MMhelper file) you want to edit.
Save:
Saves the active file to disk.
Show Control Panel:
Shows the Help Edit Menu.
Capture Key Select:
Select the trigger (Hotkey or right-mouse-button) that will start the capture process.
Help Topics Settings:
use this button to open 'Help topics setting' window
were you can define the settings for your help topics.
Show Application Tree:
Opens the 'Application Tree' window on full screen.

Back to menu.

4. Tips & Tricks

1. If you need to specify any command line parameters in order to launch your
     target software, the MMhelper enables you to run it with the 'Command Line
    Parameters' option.

2. In order to add text labels to the MMhelper toolbar buttons, place the mouse
    cursor over the toolbar, click the right-mouse-button, make sure that "Text Labels" item is checked, or, enter 'View' menu
    and make sure that "Text Labels" item is checked.

3. we recommend an order for using the capturing methods:
    To capture elements in the target software, first use 'Capture only the pointed component', if the desired element was not
    captured, use the 'Rectangle' capture method.
    Note: Use 'Capture all visible components' carefully and only if you have to.

4.  If you don't recognize certain nodes from the application tree of the software you
     have captured (that is because the node's name, that the programmer chose, in the
     'Application Tree', aren't always the same as the element's name in the software), Do this:
     Select the node that you want to locate, and use the 'Locate Window' option from
     the toolbar or from the right-mouse-button menu.

    Now you'll get a presentation of the selected node of the target software encircled
    by a flickering red and green frame, and than the focus will get back to the
    MMhelper.

5. You can rename any node from the application tree of the software you
     have captured, to a suitable and meaningful name.

6. You can use help topics of one application in a different application. Do that by
    simply dragging help topics between two applications that are open in the
    MMhelper help editor (use 'Cascade' option from 'Window' menu in order to view both applications at once). You can   
    also do it the standard method using 'Copy' and 'Paste'.

7. Using the 'External' type help topic, you can attach and 'Play' any kind of file you want. When you open an 'External' file in  
    the MMhelper, it is as if you have double-clicked it.

8. The MMhelper allows you to change any help topic's properties, in the 'Help Topic Settings' window.

9. When publishing your MMhelper help project to the end-users, it is recommended to copy the External/ Multimedia files,  
     that you have attached as help topics, to the folder 'My help projects', if the end users don't have an access to these files
     through the network.

10. In order to publish the MMhelper help project to the end user, follow the next steps:
      A. Install the MMhelper runtime engine in the end user's computer. (It is
           recommended to locate a shortcut at the end user's StartUp folder, do it by
           selecting the MMhelper runtime engine and choosing ‘Create shortcut’ from
           right-mouse-click menu, place the shortcut in Windows\Programs\StartUp).
      B. Create a folder in the name of 'My help projects', at the path:
           …\ESMMI\MMhelper 1.5, and locate the three MMhelper files
          (mht, mhc, mhs) in that folder.

11. If you have a long list of help topics you can spread it on the whole
       window by hiding the application tree. It can be done from the View
       menu or by the toolbar button.

12. If you point a help topic with the cursor, for more than one second, it will
       be automatically marked.

13. You don’t have to save your help content before ‘Testing’ it (pressing
       ‘Play’ from ‘Help Edit Menu’).
       You’ll have to save it only when you exit the MMhelper help builder.

14.  You can set any hotkey (trigger for the capturing method) that you like in the
       'Capture Key Select'. You can even use a combination of CTRL or SHIFT with
       another letter.
       Note: Before capturing it is important to verify that the Hotkey you have selected
       is not in use of the target software.

15. You can sort the list of the help topics according to 'Name', 'Type', 'Value' etc.
       To do that hit the desired tab in the head of the list.

16.  Searching for a help topics in a long list?
       Try this: Sort the list according to 'Name'. Now type the name of the topic or only
      the beginning of it continuously.

17. If you can’t recognize ‘External’/’Multimedia’ help topic that you have assign
       simply double click the help topic and the file will open.

18. For your convenience, when you select 'New project', the 'New Help Project'
       dialog box opens in the Start\programs menu so you can locate your target
       software, as it appears in your Windows 'Start' menu.

      Back to menu.

4.  Contents

1. Target Software
     The software that you are building help project for.
2. Application Tree
    The target software's captured components representation.
3. Node  
    Every node in the 'Application Tree' window represents a control or a component in the target application.
    You can attach help topics you have created in the 'Help Topic' window to the desired nodes.    
4. Help Topic
    This is a help content you create and attach to the desired component at the target application.
    To determine the general properties for the help topics, use the 'Help Topic Settings' window.
    For determining the properties of  a specific help topic simply double-click it.

    Back to menu.